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

olzzon · Julusian · commit ea2cae16a5cf · 2024-11-25T14:03:30.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
@@ -365,6 +365,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
 	}
 }
 
@@ -387,6 +388,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
@@ -50,6 +50,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
@@ -217,4 +217,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
@@ -443,6 +443,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
@@ -128,6 +128,7 @@ describe('Migrations', () => {
 							minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 							allowHold: true,
 							allowPieceDirectPlay: true,
+							enableBuckets: true,
 						},
 						mappingsWithOverrides: wrapDefaultObject({}),
 						blueprintConfigWithOverrides: wrapDefaultObject({}),
@@ -168,6 +169,7 @@ describe('Migrations', () => {
 							minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 							allowHold: true,
 							allowPieceDirectPlay: true,
+							enableBuckets: true,
 						},
 						mappingsWithOverrides: wrapDefaultObject({}),
 						blueprintConfigWithOverrides: wrapDefaultObject({}),
@@ -208,6 +210,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
@@ -170,6 +170,7 @@ describe('lib/mediaObjects', () => {
 			minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,
 			allowHold: false,
 			allowPieceDirectPlay: false,
+			enableBuckets: false,
 		}
 
 		const mockDefaultStudio = defaultStudio(protectString('studio0'))
diff --git a/packages/corelib/src/dataModel/Studio.ts b/packages/corelib/src/dataModel/Studio.ts
@@ -101,6 +101,11 @@ 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
 }
 
 export type StudioLight = Omit<DBStudio, 'mappingsWithOverrides' | 'blueprintConfigWithOverrides'>
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/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
@@ -1436,7 +1436,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
@@ -248,6 +248,20 @@ export const StudioGenericProperties = withTranslation()(
 						/>
 					</label>
 
+					<label className="field">
+						<LabelActual label={t('Enable Buckets')} />
+						<EditAttribute
+							modifiedClassName="bghl"
+							attribute="settings.enableBuckets"
+							obj={this.props.studio}
+							type="checkbox"
+							collection={Studios}
+						/>
+						<span className="text-s dimmed field-hint">
+							{t('This enables or disables buckets in the UI - enabled is the default behavior')}
+						</span>
+					</label>
+
 					<label className="field">
 						<LabelActual label={t('Enable QuickLoop')} />
 						<EditAttribute

Original file line number	Diff line number	Diff line change
`@@ -365,6 +365,7 @@ export function studioSettingsFrom(apiStudioSettings: APIStudioSettings): Comple`
`365`	`365`	`allowAdlibTestingSegment: apiStudioSettings.allowAdlibTestingSegment,`
`366`	`366`	`allowHold: apiStudioSettings.allowHold ?? true, // Backwards compatible`
`367`	`367`	`allowPieceDirectPlay: apiStudioSettings.allowPieceDirectPlay ?? true, // Backwards compatible`
	`368`	`+ enableBuckets: apiStudioSettings.enableBuckets ?? true, // Backwards compatible`
`368`	`369`	`}`
`369`	`370`	`}`
`370`	`371`
`@@ -387,6 +388,7 @@ export function APIStudioSettingsFrom(settings: IStudioSettings): Complete<APISt`
`387`	`388`	`allowAdlibTestingSegment: settings.allowAdlibTestingSegment,`
`388`	`389`	`allowHold: settings.allowHold,`
`389`	`390`	`allowPieceDirectPlay: settings.allowPieceDirectPlay,`
	`391`	`+ enableBuckets: settings.enableBuckets,`
`390`	`392`	`}`
`391`	`393`	`}`
`392`	`394`
Original file line number	Diff line number	Diff line change
`@@ -217,4 +217,5 @@ export interface APIStudioSettings {`
`217`	`217`	`allowAdlibTestingSegment?: boolean`
`218`	`218`	`allowHold?: boolean`
`219`	`219`	`allowPieceDirectPlay?: boolean`
	`220`	`+ enableBuckets?: boolean`
`220`	`221`	`}`
Original file line number	Diff line number	Diff line change
`@@ -170,6 +170,7 @@ describe('lib/mediaObjects', () => {`
`170`	`170`	`minimumTakeSpan: DEFAULT_MINIMUM_TAKE_SPAN,`
`171`	`171`	`allowHold: false,`
`172`	`172`	`allowPieceDirectPlay: false,`
	`173`	`+ enableBuckets: false,`
`173`	`174`	`}`
`174`	`175`
`175`	`176`	`const mockDefaultStudio = defaultStudio(protectString('studio0'))`