Rename @guardian/commercial -> @guardian/commercial-core (#2095)

Author: Jakeii

.changeset/every-feet-bow.md

@@ -1,5 +1,5 @@
 ---
-'@guardian/commercial': minor
+'@guardian/commercial-core': minor
 ---
 
 Export all modules in the package

.changeset/funny-ghosts-go.md

@@ -1,5 +1,5 @@
 ---
-'@guardian/commercial': minor
+'@guardian/commercial-core': minor
 ---
 
 More isolation from the commercial bundle

.changeset/tame-jars-wish.md

@@ -0,0 +1,5 @@
+---
+'@guardian/commercial-core': major
+---
+
+Package renamed

.github/workflows/beta-release-on-label.yml

@@ -13,7 +13,7 @@ jobs:
   has-permission:
     name: Check permissions
     runs-on: ubuntu-latest
-    if: github.event.label.name == '[beta] @guardian/commercial'
+    if: github.event.label.name == '[beta] @guardian/commercial-core'
     steps:
       - name: Check if organization member
         id: is_organization_member
@@ -24,10 +24,10 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
 
   release:
-    name: '@guardian/commercial'
+    name: '@guardian/commercial-core'
     runs-on: ubuntu-latest
     needs: has-permission
-    if: github.event.label.name == '[beta] @guardian/commercial'
+    if: github.event.label.name == '[beta] @guardian/commercial-core'
     steps:
       - name: Checkout
         uses: actions/checkout@v4.2.2
@@ -73,9 +73,9 @@ jobs:
 
             To install the beta version, run one of the following commands in your project directory:
             \`\`\`
-            npm install @guardian/commercial@${version}
-            pnpm add @guardian/commercial@${version}
-            yarn add @guardian/commercial@${version}
+            npm install @guardian/commercial-core@${version}
+            pnpm add @guardian/commercial-core@${version}
+            yarn add @guardian/commercial-core@${version}
             \`\`\`
             `
             })
@@ -90,5 +90,5 @@ jobs:
               issue_number: context.issue.number,
               owner: context.repo.owner,
               repo: context.repo.repo,
-              name: '[beta] @guardian/commercial'
+              name: '[beta] @guardian/commercial-core'
             })

.github/workflows/ci.yml

@@ -127,7 +127,7 @@ jobs:
         id: changesets
         uses: changesets/action@v1.5.3
         with:
-          publish: pnpm --filter @guardian/commercial changeset publish
+          publish: pnpm --filter @guardian/commercial-core changeset publish
           title: '🦋 Release package updates'
           commit: 'Bump package versions'
           setupGitUser: false

README.md

@@ -1,87 +1,29 @@
 # Commercial Monorepo
 
-This package contains the code for the commercial bundle that is loaded on all pages on theguardian.com.
+This package contains the commercial (advertising) code that is loaded on all pages on theguardian.com.
 
-There are 2 main parts to this repo:
-- The commercial bundle itself, which is a set of javascript files that is loaded on all pages on theguardian.com.
-- Some modules that are used by other parts of the Guardian codebase, such as DCR. This is published as a package to npm, `@guardian/commercial`.
-
-The `@guardian/commercial` modules are in `core/src`, everything else is only part of the commercial bundle and not the `@guardian/commercial` package.
+There are 2 packages in this repo:
+- [`@guardian/commercial-bundle`](./bundle/) The commercial bundle, which is an independent set of javascript files that is loaded on all pages on theguardian.com.
+- [`@guardian/commercial-core`](./core/) An npm package used by other parts of the Guardian codebase, such as DCR.
 
 ## Development
 
-**For working on the commercial bundle, see below. For working on the `@guardian/commercial` npm package, see [core/README.md](core/README.md).**
-
 ### Requirements
 
 -   Node
-    -   see [.nvmrc](../.nvmrc) for the current version
+    -   see [.nvmrc](./.nvmrc) for the current version
     -   the version manager [fnm](https://github.com/Schniz/fnm) is recommended with additional configuration to automatically switch on [changing directory](https://github.com/Schniz/fnm#shell-setup)
 -   pnpm
 
 ### Setup
 
 To install dependencies, run `pnpm`.
 
-To develop the bundle locally on the bundle, run `pnpm serve` to start a local server. This will watch for changes and rebuild the bundle. Serving it at `http://localhost:3031`.
-
-### Pull requests
-
-Try to write PR titles in the conventional commit format, and squash and merge when merging. That way your PR will trigger a release when you merge it (if necessary).
-
-### Working locally with DCR
-
-1.  To point DCR to the local commercial bundle, in the `dotcom-rendering/dotcom-rendering` directory run:
-
-    `COMMERCIAL_BUNDLE_URL=http://localhost:3031/graun.standalone.commercial.js PORT=3030 make dev`
-
-    This will override `commercialBundleUrl` passed via the page config from PROD/CODE.
-
-1. In another terminal start the commercial dev server to serve the local bundle:
-
-    `pnpm serve`
-
-### Testing locally with DCR
-
-To run the unit tests:
-
-`pnpm test`
-
-To run the Playwright e2e tests:
-
-Follow the steps above to run DCR against the local bundle.
-
-`pnpm playwright:run` will run the tests on the command line
-
-`pnpm playwright:open` will open the Playwright UI so you can inspect the tests as they run
-
-### Working locally with Frontend
-
-To use the bundle locally with Frontend, you can override your default Frontend configuration ([see the Frontend docs for more detail on this](https://github.com/guardian/frontend/blob/038406bb5f876afd139b4747711c76551e8a7add/docs/03-dev-howtos/14-override-default-configuration.md)) to point to a local commercial dev server. For example, save the following in `~/.gu/frontend.conf`:
-
-```
-devOverrides {
-    commercial.overrideCommercialBundleUrl="http://localhost:3031/graun.standalone.commercial.js"
-}
-```
-
-Frontend will then use the local bundle instead of the one from PROD/CODE. Frontend will pass the local bundle URL along to DCR, so you don't have to override there if you've done it in Frontend.
-
-### Linking
-
-To use the production bundle locally with Frontend, run `pnpm link` in the bundle directory. Then run `yarn link @guardian/commercial` in the frontend directory. Finally, start the frontend server as usual.
-
-Frontend will then use the local bundle instead of the one from PROD/CODE.
-
-### Testing on CODE
-
-To test the bundle on CODE, create a PR, wait for github actions to run and a riff-raff comment should appear. Click the link in the comment to confirm the CODE deployment.
-
-Although you can deploy CODE changes without deploying Frontend or DCR, it's a good idea to flag any CODE deployments on the dotcom semaphore chat in case it has an effect on anything anyone else is testing.
-
+### A Note on Deployments
+[`@guardian/commercial-bundle`](./bundle/) and [`@guardian/commercial-core`](./core/) are deployed separately.
 
-### Deploying to PROD
+`@guardian/commercial-bundle` is deployed to PROD automatically when merged to main. It does not use changesets.
 
-When you merge to main the commercial bundle will be deployed automatically and should be live within a few minutes.
+`@guardian/commercial-core` is published as an npm package and uses changesets, if you've made changes to this package, you will need to ensure you have added a changeset before merging your PR.
 
-[More details on deployment](docs/deployment/readme.md)
+A `commercial-dev` team member will then need to merge the changeset PR to release the new version.

bundle/README.md

@@ -0,0 +1,56 @@
+# Commercial Bundle
+This package contains the commercial (advertising) code that is loaded on all pages on theguardian.com.
+
+## Development
+To develop the bundle locally on the bundle, run `pnpm serve` to start a local server. This will watch for changes and rebuild the bundle. Serving it at `http://localhost:3031`.
+
+### Working locally with DCR
+
+1.  To point DCR to the local commercial bundle, in the `dotcom-rendering/dotcom-rendering` directory run:
+
+    `COMMERCIAL_BUNDLE_URL=http://localhost:3031/graun.standalone.commercial.js PORT=3030 make dev`
+
+    This will override `commercialBundleUrl` passed via the page config from PROD/CODE.
+
+1. In another terminal start the commercial dev server to serve the local bundle:
+
+    `pnpm serve`
+
+### Testing locally with DCR
+
+To run the unit tests:
+
+`pnpm test`
+
+To run the Playwright e2e tests:
+
+Follow the steps above to run DCR against the local bundle.
+
+`pnpm playwright:run` will run the tests on the command line
+
+`pnpm playwright:open` will open the Playwright UI so you can inspect the tests as they run
+
+### Working locally with Frontend
+
+To use the bundle locally with Frontend, you can override your default Frontend configuration ([see the Frontend docs for more detail on this](https://github.com/guardian/frontend/blob/038406bb5f876afd139b4747711c76551e8a7add/docs/03-dev-howtos/14-override-default-configuration.md)) to point to a local commercial dev server. For example, save the following in `~/.gu/frontend.conf`:
+
+```
+devOverrides {
+    commercial.overrideCommercialBundleUrl="http://localhost:3031/graun.standalone.commercial.js"
+}
+```
+
+Frontend will then use the local bundle instead of the one from PROD/CODE. Frontend will pass the local bundle URL along to DCR, so you don't have to override there if you've done it in Frontend.
+
+### Testing on CODE
+
+To test the bundle on CODE, create a PR, wait for github actions to run and a riff-raff comment should appear. Click the link in the comment to confirm the CODE deployment.
+
+Although you can deploy CODE changes without deploying Frontend or DCR, it's a good idea to flag any CODE deployments on the dotcom semaphore chat in case it has an effect on anything anyone else is testing.
+
+
+### Deploying to PROD
+
+When you merge to main the commercial bundle will be deployed automatically and should be live within a few minutes.
+
+[More details on deployment](docs/deployment/readme.md)

bundle/package.json

@@ -35,7 +35,7 @@
 	"dependencies": {
 		"@guardian/ab-core": "catalog:",
 		"@guardian/core-web-vitals": "11.0.0",
-		"@guardian/commercial": "workspace:*",
+		"@guardian/commercial-core": "workspace:*",
 		"@guardian/identity-auth": "^7.0.0",
 		"@guardian/identity-auth-frontend": "9.0.0",
 		"@guardian/libs": "catalog:",

bundle/src/define/Advert.spec.ts

@@ -1,5 +1,5 @@
-import type * as AdSizesType from '@guardian/commercial/ad-sizes';
-import { slotSizeMappings as slotSizeMappings_ } from '@guardian/commercial/ad-sizes';
+import type * as AdSizesType from '@guardian/commercial-core/ad-sizes';
+import { slotSizeMappings as slotSizeMappings_ } from '@guardian/commercial-core/ad-sizes';
 import { _, Advert, findSmallestAdHeightForSlot } from './Advert';
 
 const { getSlotSizeMapping } = _;
@@ -8,9 +8,9 @@ jest.mock('define/init-slot-ias', () => ({
 	initSlotIas: jest.fn(() => Promise.resolve()),
 }));
 
-jest.mock('@guardian/commercial/ad-sizes', () => {
+jest.mock('@guardian/commercial-core/ad-sizes', () => {
 	const adSizes: typeof AdSizesType = jest.requireActual(
-		'@guardian/commercial/ad-sizes',
+		'@guardian/commercial-core/ad-sizes',
 	);
 	const slotSizeMappings = adSizes.slotSizeMappings;
 	const slots = {
@@ -40,7 +40,7 @@ jest.mock('@guardian/commercial/ad-sizes', () => {
 	};
 });
 
-jest.mock('@guardian/commercial/targeting/teads-eligibility', () => ({
+jest.mock('@guardian/commercial-core/targeting/teads-eligibility', () => ({
 	isEligibleForTeads: jest.fn(),
 }));
 

bundle/src/define/Advert.ts

@@ -2,14 +2,14 @@ import {
 	createAdSize,
 	findAppliedSizesForBreakpoint,
 	slotSizeMappings,
-} from '@guardian/commercial/ad-sizes';
+} from '@guardian/commercial-core/ad-sizes';
 import type {
 	AdSize,
 	SizeMapping,
 	SlotName,
-} from '@guardian/commercial/ad-sizes';
-import type { Breakpoint } from '@guardian/commercial/breakpoint';
-import type { Advert as IAdvert } from '@guardian/commercial/types';
+} from '@guardian/commercial-core/ad-sizes';
+import type { Breakpoint } from '@guardian/commercial-core/breakpoint';
+import type { Advert as IAdvert } from '@guardian/commercial-core/types';
 import { breakpoints as sourceBreakpoints } from '@guardian/source/foundations';
 import { concatSizeMappings } from '../lib/create-ad-slot';
 import fastdom from '../lib/fastdom-promise';