feat: option to disable/enable buckets (#36)

olzzon · web-flow · commit 53672195a78c · 2024-11-20T17:38:44.000Z
diff --git a/meteor/__mocks__/defaultCollectionObjects.ts b/meteor/__mocks__/defaultCollectionObjects.ts
@@ -112,6 +112,7 @@ export function defaultStudio(_id: StudioId): DBStudio {
 			fallbackPartDuration: DEFAULT_FALLBACK_PART_DURATION,
 			allowHold: false,
 			allowPieceDirectPlay: false,
+			enableBuckets: false,
 		}),
 		_rundownVersionHash: '',
 		routeSetsWithOverrides: wrapDefaultObject({}),
diff --git a/meteor/server/api/rest/v1/typeConversion.ts b/meteor/server/api/rest/v1/typeConversion.ts
@@ -328,6 +328,7 @@ export function studioSettingsFrom(apiStudioSettings: APIStudioSettings): Comple
 		allowAdlibTestingSegment: apiStudioSettings.allowAdlibTestingSegment,
 		allowHold: apiStudioSettings.allowHold ?? true, // Backwards compatible
 		allowPieceDirectPlay: apiStudioSettings.allowPieceDirectPlay ?? true, // Backwards compatible
+		enableBuckets: apiStudioSettings.enableBuckets ?? true, // Backwards compatible
 	}
 }
 
@@ -350,6 +351,7 @@ export function APIStudioSettingsFrom(settings: IStudioSettings): Complete<APISt
 		allowAdlibTestingSegment: settings.allowAdlibTestingSegment,
 		allowHold: settings.allowHold,
 		allowPieceDirectPlay: settings.allowPieceDirectPlay,
+		enableBuckets: settings.enableBuckets,
 	}
 }
 
diff --git a/meteor/server/api/studio/api.ts b/meteor/server/api/studio/api.ts
@@ -51,6 +51,7 @@ export async function insertStudioInner(organizationId: OrganizationId | null, n
 				minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 				allowHold: false,
 				allowPieceDirectPlay: false,
+				enableBuckets: true,
 			}),
 			_rundownVersionHash: '',
 			routeSetsWithOverrides: wrapDefaultObject({}),
diff --git a/meteor/server/lib/rest/v1/studios.ts b/meteor/server/lib/rest/v1/studios.ts
@@ -189,4 +189,5 @@ export interface APIStudioSettings {
 	allowAdlibTestingSegment?: boolean
 	allowHold?: boolean
 	allowPieceDirectPlay?: boolean
+	enableBuckets?: boolean
 }
diff --git a/meteor/server/migration/0_1_0.ts b/meteor/server/migration/0_1_0.ts
@@ -35,6 +35,7 @@ export const addSteps = addMigrationSteps('0.1.0', [
 					minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 					allowHold: false,
 					allowPieceDirectPlay: false,
+					enableBuckets: true,
 				}),
 				mappingsWithOverrides: wrapDefaultObject({}),
 				blueprintConfigWithOverrides: wrapDefaultObject({}),
diff --git a/meteor/server/migration/__tests__/migrations.test.ts b/meteor/server/migration/__tests__/migrations.test.ts
@@ -127,6 +127,7 @@ describe('Migrations', () => {
 							minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 							allowHold: true,
 							allowPieceDirectPlay: true,
+							enableBuckets: true,
 						}),
 						mappingsWithOverrides: wrapDefaultObject({}),
 						blueprintConfigWithOverrides: wrapDefaultObject({}),
@@ -167,6 +168,7 @@ describe('Migrations', () => {
 							minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 							allowHold: true,
 							allowPieceDirectPlay: true,
+							enableBuckets: true,
 						}),
 						mappingsWithOverrides: wrapDefaultObject({}),
 						blueprintConfigWithOverrides: wrapDefaultObject({}),
@@ -207,6 +209,7 @@ describe('Migrations', () => {
 							minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 							allowHold: true,
 							allowPieceDirectPlay: true,
+							enableBuckets: true,
 						}),
 						mappingsWithOverrides: wrapDefaultObject({}),
 						blueprintConfigWithOverrides: wrapDefaultObject({}),
diff --git a/meteor/server/publications/pieceContentStatusUI/__tests__/checkPieceContentStatus.test.ts b/meteor/server/publications/pieceContentStatusUI/__tests__/checkPieceContentStatus.test.ts
@@ -251,6 +251,7 @@ describe('lib/mediaObjects', () => {
 			minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 			allowHold: false,
 			allowPieceDirectPlay: false,
+			enableBuckets: false,
 		}
 
 		const mockDefaultStudio = defaultStudio(protectString('studio0'))
diff --git a/packages/job-worker/src/__mocks__/defaultCollectionObjects.ts b/packages/job-worker/src/__mocks__/defaultCollectionObjects.ts
@@ -109,6 +109,7 @@ export function defaultStudio(_id: StudioId): DBStudio {
 			allowAdlibTestingSegment: true,
 			allowHold: true,
 			allowPieceDirectPlay: true,
+			enableBuckets: true,
 		}),
 		routeSetsWithOverrides: wrapDefaultObject({}),
 		routeSetExclusivityGroupsWithOverrides: wrapDefaultObject({}),
diff --git a/packages/job-worker/src/blueprints/__tests__/config.test.ts b/packages/job-worker/src/blueprints/__tests__/config.test.ts
@@ -17,6 +17,7 @@ describe('Test blueprint config', () => {
 				minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 				allowHold: true,
 				allowPieceDirectPlay: true,
+				enableBuckets: true,
 			}),
 			blueprintConfigWithOverrides: wrapDefaultObject({ sdfsdf: 'one', another: 5 }),
 		})
@@ -42,6 +43,7 @@ describe('Test blueprint config', () => {
 				minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 				allowHold: true,
 				allowPieceDirectPlay: true,
+				enableBuckets: true,
 			}),
 			blueprintConfigWithOverrides: wrapDefaultObject({ sdfsdf: 'one', another: 5 }),
 		})
diff --git a/packages/job-worker/src/playout/upgrade.ts b/packages/job-worker/src/playout/upgrade.ts
@@ -117,6 +117,7 @@ export async function handleBlueprintUpgradeForStudio(context: JobContext, _data
 		minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 		allowHold: true,
 		allowPieceDirectPlay: true,
+		enableBuckets: true,
 	}
 
 	await context.directCollections.Studios.update(context.studioId, {
diff --git a/packages/shared-lib/src/core/model/StudioSettings.ts b/packages/shared-lib/src/core/model/StudioSettings.ts
@@ -76,4 +76,9 @@ export interface IStudioSettings {
 	 * This behaviour is usally triggered by double-clicking on a piece in the GUI
 	 */
 	allowPieceDirectPlay: boolean
+
+	/**
+	 * Enable buckets - the default behavior is to have buckets.
+	 */
+	enableBuckets: boolean
 }
diff --git a/packages/webui/src/__mocks__/defaultCollectionObjects.ts b/packages/webui/src/__mocks__/defaultCollectionObjects.ts
@@ -107,6 +107,7 @@ export function defaultStudio(_id: StudioId): DBStudio {
 			minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 			allowHold: true,
 			allowPieceDirectPlay: true,
+			enableBuckets: true,
 		}),
 		_rundownVersionHash: '',
 		routeSetsWithOverrides: wrapDefaultObject({}),
diff --git a/packages/webui/src/client/ui/RundownView.tsx b/packages/webui/src/client/ui/RundownView.tsx
@@ -1475,7 +1475,8 @@ const RundownViewContent = translateWithTracker<IPropsWithReady, IState, ITracke
 		rundownHeaderLayoutId: protectString((params['rundownHeaderLayout'] as string) || ''),
 		miniShelfLayoutId: protectString((params['miniShelfLayout'] as string) || ''),
 		shelfDisplayOptions: {
-			enableBuckets: displayOptions.includes('buckets'),
+			// If buckets are enabled in Studiosettings, it can also be filtered in the URLs display options.
+			enableBuckets: !!studio?.settings.enableBuckets && displayOptions.includes('buckets'),
 			enableLayout: displayOptions.includes('layout') || displayOptions.includes('shelfLayout'),
 			enableInspector: displayOptions.includes('inspector'),
 		},
diff --git a/packages/webui/src/client/ui/Settings/Studio/Generic.tsx b/packages/webui/src/client/ui/Settings/Studio/Generic.tsx
@@ -370,6 +370,16 @@ function StudioSettings({ studio }: { studio: DBStudio }): JSX.Element {
 				{(value, handleUpdate) => <CheckboxControl value={!!value} handleUpdate={handleUpdate} />}
 			</LabelAndOverridesForCheckbox>
 
+			<LabelAndOverridesForCheckbox
+				label={t('Enable Buckets')}
+				item={wrappedItem}
+				itemKey={'enableBuckets'}
+				overrideHelper={overrideHelper}
+				hint={t('This enables or disables buckets in the UI - enabled is the default behavior')}
+			>
+				{(value, handleUpdate) => <CheckboxControl value={!!value} handleUpdate={handleUpdate} />}
+			</LabelAndOverridesForCheckbox>
+
 			<LabelAndOverridesForCheckbox
 				label={t('Enable QuickLoop')}
 				item={wrappedItem}

Original file line number	Diff line number	Diff line change
`@@ -328,6 +328,7 @@ export function studioSettingsFrom(apiStudioSettings: APIStudioSettings): Comple`
`328`	`328`	`allowAdlibTestingSegment: apiStudioSettings.allowAdlibTestingSegment,`
`329`	`329`	`allowHold: apiStudioSettings.allowHold ?? true, // Backwards compatible`
`330`	`330`	`allowPieceDirectPlay: apiStudioSettings.allowPieceDirectPlay ?? true, // Backwards compatible`
	`331`	`+ enableBuckets: apiStudioSettings.enableBuckets ?? true, // Backwards compatible`
`331`	`332`	`}`
`332`	`333`	`}`
`333`	`334`
`@@ -350,6 +351,7 @@ export function APIStudioSettingsFrom(settings: IStudioSettings): Complete<APISt`
`350`	`351`	`allowAdlibTestingSegment: settings.allowAdlibTestingSegment,`
`351`	`352`	`allowHold: settings.allowHold,`
`352`	`353`	`allowPieceDirectPlay: settings.allowPieceDirectPlay,`
	`354`	`+ enableBuckets: settings.enableBuckets,`
`353`	`355`	`}`
`354`	`356`	`}`
`355`	`357`
Original file line number	Diff line number	Diff line change
`@@ -189,4 +189,5 @@ export interface APIStudioSettings {`
`189`	`189`	`allowAdlibTestingSegment?: boolean`
`190`	`190`	`allowHold?: boolean`
`191`	`191`	`allowPieceDirectPlay?: boolean`
	`192`	`+ enableBuckets?: boolean`
`192`	`193`	`}`
Original file line number	Diff line number	Diff line change
`@@ -251,6 +251,7 @@ describe('lib/mediaObjects', () => {`
`251`	`251`	`minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,`
`252`	`252`	`allowHold: false,`
`253`	`253`	`allowPieceDirectPlay: false,`
	`254`	`+ enableBuckets: false,`
`254`	`255`	`}`
`255`	`256`
`256`	`257`	`const mockDefaultStudio = defaultStudio(protectString('studio0'))`
Original file line number	Diff line number	Diff line change
`@@ -117,6 +117,7 @@ export async function handleBlueprintUpgradeForStudio(context: JobContext, _data`
`117`	`117`	`minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,`
`118`	`118`	`allowHold: true,`
`119`	`119`	`allowPieceDirectPlay: true,`
	`120`	`+ enableBuckets: true,`
`120`	`121`	`}`
`121`	`122`
`122`	`123`	`await context.directCollections.Studios.update(context.studioId, {`