DMED-119 - Spike: direktes Einbinden der edu-sharing-Suchumgebung in den "Lern-Store" der SVS #2933

bergatco · 2023-11-29T09:41:09Z

Short Description

The aim of this spike is to evaluate how the edu-sharing search environment can best be integrated as a "learning store" within the school cloud network software.

Links to Ticket and related Pull-Requests

https://ticketsystem.dbildungscloud.de/browse/DMED-119
hpi-schul-cloud/dof_app_deploy#713
hpi-schul-cloud/schulcloud-server#4692
hpi-schul-cloud/schulcloud-client#3387
hpi-schul-cloud/oeh-search-etl#50

Links to deployments (dev environments) :
https://dmed-119-integration-of-search-environment.dbc.dbildungscloud.dev/
https://dmed-119-integration-of-search-environment.nbc.dbildungscloud.dev/
https://dmed-119-integration-of-search-environment.brb.dbildungscloud.dev/

Link to deployments (in test environment) :
https://test.mediathek.dev.dbildungsplattform.de/

Changes

Data-security

Deployment

New Repos, NPM packages or vendor scripts

Screenshots of UI changes

Checklist before merging

QA: In addition to review, the code has been manually tested (if manual testing is possible)
PO: Any deviation from requirements was agreed with Product-Owner / ticket author / support-team
DEV: Every new component is implemented having accessibility in mind (e.g. aria-label, role property)

Notice: Please keep this Pull-Request as a Draft (or add WIP label), until it is ready to be reviewed

sonarqubecloud · 2023-11-29T14:18:24Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

This reverts commit 5d24415.

sonarqubecloud · 2024-01-29T06:47:20Z

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

accesslint

There are accessibility issues in these changes.

public/vendor/edu-sharing/assets/cordova/android/plugins/cordova-plugin-camera/www/Camera.js

public/vendor/edu-sharing/assets/cordova/android/cordova.js

public/vendor/edu-sharing/assets/cordova/ios/cordova.js

public/vendor/edu-sharing/assets/cordova/android/cordova.js

public/vendor/edu-sharing/assets/cordova/ios/cordova.js

sonarqubecloud · 2024-07-08T06:13:41Z

Quality Gate failed

Failed conditions
5 Security Hotspots
0.0% Coverage on New Code (required ≥ 80%)
4.8% Duplication on New Code (required ≤ 3%)
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

SevenWaysDP · 2024-09-09T06:23:01Z

src/pages/LernStoreOverview.page.vue

@@ -254,7 +100,8 @@ watchDebounced(
 	flex-direction: column;
 	justify-content: space-between;
 	width: 100%;
-	min-height: calc(100vh - var(--sidebar-item-height));
+	min-height: calc(100vh - var(--sidebar-item-height) - 105.58px);


Do you have to work with fixed values here?

SevenWaysDP · 2024-09-09T09:52:26Z

src/components/edu-sharing/EduSharingWrapper.vue

+<style scoped>
+.main-container {
+	min-height: 0;
+	flex-grow: 1;
+	display: flex;
+	flex-direction: column;
+	gap: 20px;
+}
+.search-form {
+	height: 64px;
+	flex-shrink: 0;
+	padding: 10px 16px;
+	background: #f3f5f7;
+}
+.search-input {
+	width: 500px;
+	border-radius: 2px;
+	border: 1px solid var(--Secondary-v-secondary-base, #54616e);
+	background: var(--shades---v-white-base, #fff);
+}
+edu-sharing-app {
+	flex-grow: 1;
+}
+:deep(.v-field) {
+	height: 44px;
+}


muss so viel custom css sein?

SevenWaysDP · 2024-09-10T06:21:02Z

src/components/edu-sharing/EduSharingWrapper.vue

+.main-container {
+	min-height: 0;
+	flex-grow: 1;
+	display: flex;
+	flex-direction: column;
+	gap: 20px;
+}
+.search-form {
+	height: 64px;
+	flex-shrink: 0;
+	padding: 10px 16px;
+	background: #f3f5f7;
+}
+.search-input {
+	width: 500px;
+	border-radius: 2px;
+	border: 1px solid var(--Secondary-v-secondary-base, #54616e);
+	background: var(--shades---v-white-base, #fff);
+}
+edu-sharing-app {
+	flex-grow: 1;
+}
+:deep(.v-field) {
+	height: 44px;
+}


Warum so viel eigene styles?

CeEv · 2024-09-16T11:03:40Z

config/webpack/dev-server-config.js

@@ -39,15 +50,25 @@ const createH5pEditorProxy = () => {
 	return h5pEditorProxy;
 };

+const createEduSharingRepoProxy = () => {


Warum benötigt man ein eduSharingProxy und ein eduSharingRepoProxy? Was ist der Unterschied zwischen beiden?

CeEv · 2024-09-16T11:08:43Z

config/webpack/dev-server-config.js

@@ -73,6 +98,20 @@ const createDevServerConfig = () => {
 				},
 			});

+			// Copy assets before the dev server starts
+			const __base = path.resolve(__dirname, "../..");


Es wäre super wenn der Code dafür noch unter einer Funktion mit bezeichnenden Namen geclustert wird. Ehrlich gesagt müsste ich aber noch mal über das warum es notwendig ist nachdenken. Bzw. hier wäre drüber reden hilfreich.

Sind die ganzen Änderung potentiel etwas das hinter ein feature flag liegen sollten?

CeEv · 2024-09-16T11:15:02Z

src/components/edu-sharing/EduSharingWrapper.vue

+			event.preventDefault();
+			const data = new FormData(event.target);
+			const searchString = data.get("searchString");
+			const eduSharingApp = document.getElementsByTagName("edu-sharing-app")[0];


document.getElementsByTagName("edu-sharing-app")[0] = erstes Element von irgendwas externen klinkt jetzt erstmal nicht nach Langzeit Maintaince save.

CeEv · 2024-09-16T11:20:39Z

src/components/edu-sharing/EduSharingWrapper.vue

+		document.body.appendChild(styles);
+
+		// retrieve the valid session ticket
+		(async () => {


Ich kann dir nicht sagen wie es aussehen muss. Aber die api zur Komponente zu importieren und beim mount ein async einzubauen klinkt erstmal nicht richtig.

CeEv · 2024-09-16T11:21:59Z

src/components/edu-sharing/EduSharingWrapper.vue

+				envConfigModule.getEnv.EDU_SHARING__API_URL + "/rest",
+		};
+
+		const runtime = document.createElement("script");


createElement
setAttribut
appendChild
etc.. in einer vue Komponente klinkt nicht nach state of the art.

CeEv · 2024-09-16T11:35:01Z

src/composables/edu-sharing-api.composable.ts

+} from "@/eduSharingApi/v3";
+import { $axios } from "@/utils/api";
+
+export const useEduSharingApi = () => {


Nur so als Frage sollte es ein composal geben das -api heißt?
Ich würde erwarten das ein composal maximal fachlichkeit ausdrückt und das es eine Datenquelle dahinter gibt, kann sein muss aber nicht, selbst die Art der Quelle ob Browser Cookie, json, api request dahinter liegt.
Evtl. ist es nur das umbennen des Files.

CeEv · 2024-09-16T11:39:53Z

src/eduSharingApi/v3/api.ts

+/* tslint:disable */
+/* eslint-disable */
+/**
+ * HPI Schul-Cloud Server API


Das hatten wir doch schon im backend.
Ich glaube das sollte SVS Backend API sein. Wobei das ja eigentlich eduSharing ist.

CeEv · 2024-09-16T11:40:20Z

src/eduSharingApi/v3/api.ts

+/* eslint-disable */
+/**
+ * HPI Schul-Cloud Server API
+ * This is v3 of HPI Schul-Cloud Server. Checkout /docs for v1.


Hier das gleiche Minus HPI, + SVS

CeEv · 2024-09-16T11:40:40Z

src/eduSharingApi/v3/common.ts

+/* tslint:disable */
+/* eslint-disable */
+/**
+ * HPI Schul-Cloud Server API


CeEv · 2024-09-16T11:40:50Z

src/eduSharingApi/v3/configuration.ts

+/* tslint:disable */
+/* eslint-disable */
+/**
+ * HPI Schul-Cloud Server API


CeEv · 2024-09-16T11:41:05Z

src/eduSharingApi/v3/index.ts

+/* eslint-disable */
+/**
+ * HPI Schul-Cloud Server API
+ * This is v3 of HPI Schul-Cloud Server. Checkout /docs for v1.


CeEv · 2024-09-16T11:41:41Z

src/pages/LernStoreOverview.page.vue

-				</transition>
-			</div>
-			<content-edu-sharing-footer class="content__footer" />
+			<EduSharingWrapper />


Big bang, oder feature flag?
Was ist mit sowas wie stores die evtl. noch rum liegen?

sonarqubecloud · 2024-09-23T08:12:37Z

Quality Gate failed

Failed conditions
1 Security Hotspot
0.0% Coverage on New Code (required ≥ 80%)
8.8% Duplication on New Code (required ≤ 3%)

See analysis details on SonarCloud

DMED-119 - use iFrame to incorporate edu-sharing search environment

809a67f

bergatco added the WIP someone is working on that label Nov 29, 2023

bergatco self-assigned this Nov 29, 2023

bergatco mentioned this pull request Nov 29, 2023

DMED-119 - Spike: direktes Einbinden der edu-sharing-Suchumgebung in den "Lern-Store" der SVS hpi-schul-cloud/dof_app_deploy#713

Open

1 task

bergatco and others added 2 commits November 29, 2023 10:41

Merge branch 'main' into DMED-119-integration-of-search-environment

732215c

DMED-119 - add CSP exceptions for edu-sharing search env

5447ebc

bergatco added 5 commits January 4, 2024 09:15

Merge branch 'main' into DMED-119-integration-of-search-environment

04579e3

Merge branch 'main' into DMED-119-integration-of-search-environment

a2477fc

Merge branch 'main' into DMED-119-integration-of-search-environment

84cdc0d

Merge branch 'main' into DMED-119-integration-of-search-environment

6553556

Merge branch 'main' into DMED-119-integration-of-search-environment

a992fb5

bergatco mentioned this pull request Jan 12, 2024

DMED-119 - Spike: direktes Einbinden der edu-sharing-Suchumgebung in den "Lern-Store" der SVS hpi-schul-cloud/schulcloud-server#4692

Draft

3 tasks

bergatco and others added 2 commits January 16, 2024 08:31

Merge branch 'main' into DMED-119-integration-of-search-environment

5fc0edd

DMED-119 - add edu-sharing repo path to img-src in CSP

5d24415

bergatco mentioned this pull request Jan 16, 2024

DMED-119 - Spike: direktes Einbinden der edu-sharing-Suchumgebung in den "Lern-Store" der SVS hpi-schul-cloud/schulcloud-client#3387

Closed

3 tasks

bergatco and others added 3 commits January 16, 2024 11:26

Revert "DMED-119 - add edu-sharing repo path to img-src in CSP"

f3a0254

This reverts commit 5d24415.

Merge branch 'main' into DMED-119-integration-of-search-environment

b4e552b

Merge branch 'main' into DMED-119-integration-of-search-environment

0197e35

bergatco and others added 5 commits March 1, 2024 08:14

Merge branch 'main' into DMED-119-integration-of-search-environment

ce53db9

Merge branch 'main' into DMED-119-integration-of-search-environment

550aece

Merge branch 'main' into DMED-119-integration-of-search-environment

5fedcda

Merge branch 'main' into DMED-119-integration-of-search-environment

8265e7f

DMED-119 - add edu-sharing search via web component

0b09fe0

accesslint bot reviewed Mar 15, 2024

View reviewed changes

public/vendor/edu-sharing/assets/cordova/android/plugins/cordova-plugin-camera/www/Camera.js Outdated Show resolved Hide resolved

github-advanced-security bot found potential problems Mar 15, 2024

View reviewed changes

bergatco and others added 3 commits March 15, 2024 10:02

Merge branch 'main' into DMED-119-integration-of-search-environment

acb6670

Merge branch 'main' into DMED-119-integration-of-search-environment

cdff7b9

DMED-119 - point edu-sharing web component to our own test instance

f733737

bergatco added 5 commits July 1, 2024 09:28

Merge branch 'main' into DMED-119-integration-of-search-environment

dd9ce6e

Merge branch 'main' into DMED-119-integration-of-search-environment

30f365f

Merge branch 'main' into DMED-119-integration-of-search-environment

8774d1c

Merge branch 'main' into DMED-119-integration-of-search-environment

1c055e0

Merge branch 'main' into DMED-119-integration-of-search-environment

c350394

This was referenced Jul 16, 2024

DMED-119 - Spike: direktes Einbinden der edu-sharing-Suchumgebung in den "Lern-Store" der SVS hpi-schul-cloud/oeh-search-etl#47

Closed

DMED-119 - BC-8072 - Update "master_schulcloud" from "master" hpi-schul-cloud/oeh-search-etl#50

Merged

bergatco and others added 2 commits August 26, 2024 08:13

Merge branch 'main' into DMED-119-integration-of-search-environment

2d955d9

Merge branch 'main' into DMED-119-integration-of-search-environment

579a385

mamutmk5 added the auto-extend-activation-time label Aug 29, 2024

bergatco and others added 9 commits September 4, 2024 06:59

Merge branch 'main' into DMED-119-integration-of-search-environment

de4936b

DMED-119 - update search input styling and layout

8144ecc

DMED-119 - use new npm package instead of external files

c2485c1

DMED-119 - fix wrong pathes in webpack config

6e66c5d

DMED-119 - add copying of web component files to Dockerfile

f663dc5

Merge branch 'main' into DMED-119-integration-of-search-environment

eb3c683

DMED-119 - fix handling of web component files

2da05f3

Merge branch 'main' into DMED-119-integration-of-search-environment

1c07aac

DMED-119 - fix import statement for mdiMagnify in EduSharingWrapper

b0a4edb

SevenWaysDP reviewed Sep 10, 2024

View reviewed changes

Merge branch 'main' into DMED-119-integration-of-search-environment

02df50a

CeEv reviewed Sep 16, 2024

View reviewed changes

CeEv requested changes Sep 16, 2024

View reviewed changes

bergatco and others added 3 commits September 18, 2024 09:43

DMED-119 - update CSP to include YouTube embeds

7c2540d

Merge branch 'main' into DMED-119-integration-of-search-environment

656a7fd

DMED-119 - update ngx-edu-sharing-app-as-web-component to version 9.1.1

a267658

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DMED-119 - Spike: direktes Einbinden der edu-sharing-Suchumgebung in den "Lern-Store" der SVS #2933

DMED-119 - Spike: direktes Einbinden der edu-sharing-Suchumgebung in den "Lern-Store" der SVS #2933

bergatco commented Nov 29, 2023 •

edited

Loading

sonarqubecloud bot commented Nov 29, 2023

sonarqubecloud bot commented Jan 29, 2024

accesslint bot left a comment

sonarqubecloud bot commented Jul 8, 2024

SevenWaysDP Sep 9, 2024

SevenWaysDP Sep 9, 2024

SevenWaysDP Sep 10, 2024

CeEv Sep 16, 2024

CeEv Sep 16, 2024

CeEv Sep 16, 2024

CeEv Sep 16, 2024

CeEv Sep 16, 2024

CeEv Sep 16, 2024

CeEv Sep 16, 2024

CeEv Sep 16, 2024

CeEv Sep 16, 2024

CeEv Sep 16, 2024

CeEv Sep 16, 2024

CeEv Sep 16, 2024

sonarqubecloud bot commented Sep 23, 2024

DMED-119 - Spike: direktes Einbinden der edu-sharing-Suchumgebung in den "Lern-Store" der SVS #2933

Are you sure you want to change the base?

DMED-119 - Spike: direktes Einbinden der edu-sharing-Suchumgebung in den "Lern-Store" der SVS #2933

Conversation

bergatco commented Nov 29, 2023 • edited Loading

Short Description

Links to Ticket and related Pull-Requests

Changes

Data-security

Deployment

New Repos, NPM packages or vendor scripts

Screenshots of UI changes

Checklist before merging

sonarqubecloud bot commented Nov 29, 2023

sonarqubecloud bot commented Jan 29, 2024

Quality Gate passed

accesslint bot left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Jul 8, 2024

Quality Gate failed

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Sep 23, 2024

Quality Gate failed

bergatco commented Nov 29, 2023 •

edited

Loading