From ec59f3e388efbbe71687eb4fa396f7be519f74d2 Mon Sep 17 00:00:00 2001 From: Jasper Boeijenga Date: Thu, 12 Oct 2023 15:01:28 +0200 Subject: [PATCH 1/5] Updated GA plugin playgrounds Signed-off-by: Jasper Boeijenga --- plugins/analytics-module-ga/dev/index.tsx | 16 ++++++++++++++-- plugins/analytics-module-ga4/dev/index.tsx | 21 +++++++++++++++++---- 2 files changed, 31 insertions(+), 6 deletions(-) diff --git a/plugins/analytics-module-ga/dev/index.tsx b/plugins/analytics-module-ga/dev/index.tsx index 74b3439cff..8c0d7f9607 100644 --- a/plugins/analytics-module-ga/dev/index.tsx +++ b/plugins/analytics-module-ga/dev/index.tsx @@ -15,11 +15,23 @@ */ import React from 'react'; import { createDevApp } from '@backstage/dev-utils'; -import { analyticsModuleGA } from '../src/plugin'; import { Playground } from './Playground'; +import { + analyticsApiRef, + configApiRef, + identityApiRef, +} from '@backstage/core-plugin-api'; +import { GoogleAnalytics } from '../src'; createDevApp() - .registerPlugin(analyticsModuleGA) + .registerApi({ + api: analyticsApiRef, + deps: { configApi: configApiRef, identityApi: identityApiRef }, + factory: ({ configApi, identityApi }) => + GoogleAnalytics.fromConfig(configApi, { + identityApi, + }), + }) .addPage({ path: '/ga', title: 'GA Playground', diff --git a/plugins/analytics-module-ga4/dev/index.tsx b/plugins/analytics-module-ga4/dev/index.tsx index eb694498f5..4fe8496b35 100644 --- a/plugins/analytics-module-ga4/dev/index.tsx +++ b/plugins/analytics-module-ga4/dev/index.tsx @@ -13,11 +13,17 @@ * See the License for the specific language governing permissions and * limitations under the License. */ -import React from 'react'; +import { + analyticsApiRef, + configApiRef, + createPlugin, + identityApiRef, +} from '@backstage/core-plugin-api'; import { createDevApp } from '@backstage/dev-utils'; -import { Playground } from './Playground'; +import React from 'react'; -import { createPlugin } from '@backstage/core-plugin-api'; +import { GoogleAnalytics4 } from '../src'; +import { Playground } from './Playground'; /** * @deprecated Importing and including this plugin in an app has no effect. @@ -29,7 +35,14 @@ export const analyticsModuleGA4 = createPlugin({ id: 'analytics-provider-ga4', }); createDevApp() - .registerPlugin(analyticsModuleGA4) + .registerApi({ + api: analyticsApiRef, + deps: { configApi: configApiRef, identityApi: identityApiRef }, + factory: ({ configApi, identityApi }) => + GoogleAnalytics4.fromConfig(configApi, { + identityApi, + }), + }) .addPage({ path: '/ga4', title: 'GA4 Playground', From 5a4437cf0c5aebc8e078d0fe1c2fa316f456435c Mon Sep 17 00:00:00 2001 From: Jasper Boeijenga Date: Thu, 12 Oct 2023 15:04:57 +0200 Subject: [PATCH 2/5] Added changeset Signed-off-by: Jasper Boeijenga --- .changeset/seven-lions-attack.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .changeset/seven-lions-attack.md diff --git a/.changeset/seven-lions-attack.md b/.changeset/seven-lions-attack.md new file mode 100644 index 0000000000..4b95e766b5 --- /dev/null +++ b/.changeset/seven-lions-attack.md @@ -0,0 +1,6 @@ +--- +'@backstage/plugin-analytics-module-ga4': patch +'@backstage/plugin-analytics-module-ga': patch +--- + +Updated dev playground to make use of registerApi instead of deprecated registerPlugin From 859216954049dd2fde50b0e384251b1ba0861ef5 Mon Sep 17 00:00:00 2001 From: Jasper Boeijenga Date: Thu, 12 Oct 2023 15:13:33 +0200 Subject: [PATCH 3/5] Remove local plugin Signed-off-by: Jasper Boeijenga --- plugins/analytics-module-ga4/dev/index.tsx | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/plugins/analytics-module-ga4/dev/index.tsx b/plugins/analytics-module-ga4/dev/index.tsx index 4fe8496b35..8b30c0e081 100644 --- a/plugins/analytics-module-ga4/dev/index.tsx +++ b/plugins/analytics-module-ga4/dev/index.tsx @@ -16,7 +16,6 @@ import { analyticsApiRef, configApiRef, - createPlugin, identityApiRef, } from '@backstage/core-plugin-api'; import { createDevApp } from '@backstage/dev-utils'; @@ -25,15 +24,6 @@ import React from 'react'; import { GoogleAnalytics4 } from '../src'; import { Playground } from './Playground'; -/** - * @deprecated Importing and including this plugin in an app has no effect. - * This will be removed in a future release. - * - * @public - */ -export const analyticsModuleGA4 = createPlugin({ - id: 'analytics-provider-ga4', -}); createDevApp() .registerApi({ api: analyticsApiRef, From f092e285c065ea0d031182b406808d37318ae8d0 Mon Sep 17 00:00:00 2001 From: Jasper Boeijenga Date: Thu, 12 Oct 2023 15:25:37 +0200 Subject: [PATCH 4/5] Udpated changeset Signed-off-by: Jasper Boeijenga --- .changeset/seven-lions-attack.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/seven-lions-attack.md b/.changeset/seven-lions-attack.md index 4b95e766b5..2a7753fce3 100644 --- a/.changeset/seven-lions-attack.md +++ b/.changeset/seven-lions-attack.md @@ -3,4 +3,4 @@ '@backstage/plugin-analytics-module-ga': patch --- -Updated dev playground to make use of registerApi instead of deprecated registerPlugin +Updated dev playground to make use of registerApi instead of registering the deprecated plugins. From 18961446c2ff8d19fc753a10a38bb58ef6da6c6f Mon Sep 17 00:00:00 2001 From: Jasper Boeijenga Date: Mon, 23 Oct 2023 13:30:56 +0200 Subject: [PATCH 5/5] Removed changeset Signed-off-by: Jasper Boeijenga --- .changeset/seven-lions-attack.md | 6 ------ 1 file changed, 6 deletions(-) delete mode 100644 .changeset/seven-lions-attack.md diff --git a/.changeset/seven-lions-attack.md b/.changeset/seven-lions-attack.md deleted file mode 100644 index 2a7753fce3..0000000000 --- a/.changeset/seven-lions-attack.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -'@backstage/plugin-analytics-module-ga4': patch -'@backstage/plugin-analytics-module-ga': patch ---- - -Updated dev playground to make use of registerApi instead of registering the deprecated plugins.